home *** CD-ROM | disk | FTP | other *** search
/ ASP Advantage 1993 / The Association of Shareware Professionals Advantage CD-ROM 1993.iso / files / writions / boxer50b / reconfig.doc < prev    next >
Text File  |  1993-04-06  |  9KB  |  171 lines
  1.  
  2. INTRODUCTION:
  3. -------------
  4.  
  5. The RECONFIG utility can be used to create a new keyboard definition
  6. file for BOXER.  The keyboard definition file associates the
  7. editor's commands with the keys which activate those commands.  You
  8. may wish to use RECONFIG to create the file DEFAULT.KEY to match an
  9. editor or word processor with which you are already familiar.
  10.  
  11.  
  12. USING A SUPPLIED DEFINITION FILE:
  13. ---------------------------------
  14.  
  15. If you would simply like to permanently install one of the ready-made
  16. definition files as the default, do this, for example:
  17.  
  18.                 COPY WORDSTAR.KEY DEFAULT.KEY
  19.  
  20. In this case, you will not need to use the RECONFIG utility - unless
  21. you find you would like to further alter the supplied definition file.
  22.  
  23. You can create an assignment reference listing for one of the supplied
  24. definition files by invoking RECONFIG with just the name of that file.
  25. For example:
  26.  
  27.                 RECONFIG WORDSTAR.KEY
  28.  
  29. will create a file named WORDSTAR.REF which documents the command key
  30. assignments in WORDSTAR.KEY.  You may wish to print this file to create a
  31. hard copy reference for the new assignments.
  32.  
  33.  
  34. USING RECONFIG TO CREATE A NEW DEFINITION FILE:
  35. -----------------------------------------------
  36.  
  37. The RECONFIG utility should be run from within BOXER's home directory,
  38. usually \BOXER.  The file BOXER.KEY contains key assignments which match
  39. those contained within the BOXER executable, B.EXE.  BOXER.KEY is not
  40. loaded on startup; it is provided only to make it easy to make changes to
  41. BOXER's default assignments.  Rather, BOXER will automatically load the
  42. file DEFAULT.KEY, if present.  It is recommended that you maintain the
  43. BOXER.KEY file as is, so that you can always return to the default layout
  44. if needed.
  45.  
  46. To begin a keyboard reassignment session invoke the utility as follows:
  47.  
  48.                 RECONFIG <INPUT.KEY> <OUTPUT.KEY>
  49.  
  50. The <INPUT.KEY> argument is the filename of the key map file to begin
  51. working from.  The <OUTPUT.KEY> argument is the name of the new file to
  52. create.  The filenames may be the same.  Both of these filenames should
  53. have a .KEY file extension.  BOXER requires that all keyboard definition
  54. files have this file extension.
  55.  
  56. If you would like to make changes to BOXER's default layout, you would
  57. invoke the utility as follows:
  58.  
  59.                 RECONFIG BOXER.KEY DEFAULT.KEY
  60.  
  61. The RECONFIG utility will prompt you to press a key (or a sequence of up to
  62. 3 keys) for each of BOXER's commands which may be reconfigured.  Some
  63. special commands - such as Enter, Escape, Delete and Backspace - are not
  64. reconfigurable.  The current assignment for a command is shown labeled
  65. 'old'.  If you are satisfied with the current assignment you may simply
  66. press Enter to leave it unchanged.  If you wish to change the assignment,
  67. press the key sequence you would like the command to be assigned to.  The
  68. names of the keys you press are echoed to the screen.  Press Enter to signal
  69. the end of a 1 or 2 key sequence.  A sequence of 3 keys automatically moves
  70. to the next command.
  71.  
  72. You may return to a previous assignment by pressing 'P' as the first key in
  73. an assignment. If pressed as the 2nd or 3rd key in the sequence, the 'P'
  74. will be added to the sequence. This may be helpful to correct a mistake that
  75. has been made. When an assignment conflict occurs, the number of the earlier
  76. conflict is reported. The 'J' command can be used to jump back to a prior
  77. assignment by number.
  78.  
  79. You can specify that a command is to be available only from the pull-down
  80. menu by pressing 'M' as the first key of an assignment.  If pressed as the
  81. 2nd or 3rd key in the sequence, the 'M' will be added to the sequence.  You
  82. should avoid using 'M' for frequently used editor commands, as you may tire
  83. of accessing these from the pull-down menus.
  84.  
  85. You may abort the session at any point by pressing Escape as the first key
  86. in an assignment.  If pressed as the 2nd or 3rd key in the sequence, the
  87. 'Escape' will be added to the sequence.  Aborting will cause all changes to
  88. be lost, so you must confirm your intention to do so.
  89.  
  90. After the session has been completed you may choose to save or abort your
  91. changes.  If you save your changes, a new definition file will be created
  92. using the output name you specified on the command line.  A listing of the
  93. new assignments will be written to a file of that same name with the file
  94. extension ".REF".  You may wish to print this file for use as a reference
  95. to the command assignments which were used.
  96.  
  97.  
  98. USING THE ESCAPE KEY FOR PULL-DOWN MENU ACCESS:
  99. -----------------------------------------------
  100. The use of the Escape key for main menu access is possible with the command
  101. line/environment option "-5".  Due to the special nature of the Escape key,
  102. it is not possible to simply assign that key to access the menus in the
  103. usual way with RECONFIG.  By placing a "-5" in the BOXER environment
  104. string, the Escape key will activate the main menu system.
  105.  
  106.  
  107. HOME-HOME-HOME STYLE CURSOR MOTION:
  108. -----------------------------------
  109. It is also possible to configure BOXER to perform the style of cursor
  110. motion wherein a single command will jump successively to start of line,
  111. start of screen, and start of file.  Typically, the Home key is used for
  112. this function, and the End key for the analogous motion to end of line, end
  113. of screen and end of file.  As this style of cursor motion entails a
  114. program logic change, its activation is by an option flag, and possibly a
  115. key reassignment.  The "-6" option flag will activate this style of cursor
  116. motion.  If the Home/End keys are desired to be the activating keys,
  117. reassign these keys for the beginning/end of line commands, respectively.
  118. The Top and Btm of screen commands can then be assigned to <menu>, as these
  119. commands will be available on Home-Home and End-End, respectively.
  120.  
  121. IMPORTANT NOTES:
  122. ----------------
  123. There is a restriction placed on the use of multi-key sequences.  If you
  124. have assigned a command to <Ctrl X><Ctrl W>, for example, you may not also
  125. use the lone key sequence <Ctrl X> for another command.  In this example,
  126. <Ctrl X> has become a "lead-in" key - a key which will cause the editor to
  127. wait for another key to be pressed before executing a command.
  128.  
  129. In a sequence which contains alphabetic characters in positions 2 or 3
  130. (such as <Ctrl X><A>), the case of the letter is insignificant.  This
  131. ensures that the key sequence will be properly interpreted within the
  132. editor regardless of the shift state (upper/lower).
  133.  
  134. You will be provided a chance to make alternate assignments for the Up,
  135. Down, Left, Right, Page Up, and Page Down commands.  These commands are
  136. regarded specially by BOXER, so they will additionally retain their
  137. intuitive assignments to the Arrow and PgUp/PgDn keys regardless of the
  138. assignments you make.  This permits you to use Ctrl key assignments (for
  139. example) for these commands without losing the natural assignments.
  140.  
  141. The Alt-0 through Alt-9 keys are not allowed to occupy the first position in
  142. a key sequence.  These keys are reserved by BOXER for inserting embedded
  143. printer codes.
  144.  
  145. The +, -, and * keys on the numeric keypad can resume their conventional
  146. functions by using RECONFIG to relieve them from their command key
  147. assignments.  Likewise the / key on the numeric keypad, if present, can be
  148. used as a command key.  Unless assigned to a command, it will retain its
  149. natural function.
  150.  
  151. BOXER can recognize a number of key sequences which are particular to the
  152. enhanced keyboards.  You should feel free to use these during reassignment,
  153. provided you have such a keyboard.  For example, the Alt shift applied to
  154. any of the cursor motion keys will generate unique sequences.  Feel free
  155. to experiment!
  156.  
  157. During reassignment, a few commands will appear twice - the second
  158. instance being labeled "dup".  This indicates that two different key
  159. sequences can be used for this command.  If you have no interest in
  160. supplying an alternate sequence, simply assign the second of the pair to
  161. the menu with the 'M' command.
  162.  
  163. The ready-made definition files supplied represent our best effort at
  164. emulating other editors.  No two editors are identical, and it can be
  165. difficult to create a one-to-one map for differing features or styles of
  166. operation.  Also, we are not intimately familiar with other editors (we show
  167. a preference for using BOXER), so you may be able to improve on the supplied
  168. files.  If you do, please send in your suggestions.  If you create
  169. definition files for other popular editors, we will likely include them
  170. in future releases.
  171.